Skip to content

docs(education): add hands-on build-and-eval workshop#717

Merged
potiuk merged 1 commit into
apache:mainfrom
justinmclean:education-workshops
Jul 4, 2026
Merged

docs(education): add hands-on build-and-eval workshop#717
potiuk merged 1 commit into
apache:mainfrom
justinmclean:education-workshops

Conversation

@justinmclean

Copy link
Copy Markdown
Member

Summary

Adds docs/education/workshops.md as a self-serve, hands-on workshop. In about 90 minutes the reader builds one concrete skill (dependency-licence-check) end to end: scaffold it, write a two-step body that follows the data-not-instructions, propose-confirm-act, and placeholder rules, give it an eval suite with a normal case and a prompt-injection case, then run and harden it. Each exercise carries a learning objective, a done-checkpoint, and a self-check.

This is an actual workshop in the shape the maintainer-education spec calls for (learning objectives, hands-on exercises, self-checks), not office-hours or pairing-session material. It presumes no PMC decision on cadence, hosting, or recordings: it ships the exercise, not a schedule.

Follows the education house style (SPDX header, Words-used glossary, flat H2), stays project-agnostic with placeholders (PRINCIPLE 12), and lands under Apache-2.0 (PRINCIPLE 17). Commands and the eval-fixture layout were verified against the repo.

Generated-by: Claude (Opus 4.8)

Type of change

  • Skill change (.claude/skills/<name>/) — eval fixtures updated below
  • Tool / bridge contract (tools/<system>/*.md)
  • Python package (tools/*/ with pyproject.toml)
  • Groovy reference impl
  • Cross-cutting (RFC, AGENTS.md, sandbox, privacy-LLM)
  • Documentation (docs/, README.md, CONTRIBUTING.md)
  • Project template (projects/_template/)
  • CI / dev loop (prek, workflows, validators)
  • Other:

Test plan

  • prek run --all-files passes
  • For Python packages touched: uv run pytest / ruff check / mypy passes
  • For Groovy bridges touched: command-line invocation tested end-to-end
  • For skill changes: eval suite passes for the affected skill
    (PYTHONPATH=tools/skill-evals/src python3 -m skill_evals.runner tools/skill-evals/evals/<skill>/)
  • For skill behaviour changes: a new or updated eval fixture is included in this PR
    (a regression test for the bug fixed / the behaviour added — see CONTRIBUTING.md)
  • Other:

@justinmclean justinmclean self-assigned this Jul 4, 2026
@justinmclean

Copy link
Copy Markdown
Member Author

note teh missing linked file will exist when the other education PRs are merged

Self-paced 90-minute lab that builds one small skill with an eval suite,
and flip its row in the education index to a live link.

Generated-by: Claude Code (Opus 4.8)
@potiuk potiuk force-pushed the education-workshops branch from 13ad713 to a340d91 Compare July 4, 2026 17:05

@potiuk potiuk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-reviewed after rebase onto main (post-#716). The original CI failure — lychee reporting broken links to your-first-skill.md / eval-driven-development.md / pattern-catalogue.md — is resolved now that those sibling pages exist on main; lychee passes and the required prek check is green. Minimal diff: adds docs/education/workshops.md (a self-paced 90-minute lab) and flips its row in the education README to a live link + Ready. Placeholder-clean, no emojis. LGTM.

@potiuk potiuk merged commit d57a8df into apache:main Jul 4, 2026
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants